home *** CD-ROM | disk | FTP | other *** search
/ World of Video / World of Video.iso / gfxprograms / conversion / pbmplus / doc / pgm.doc < prev    next >
Text File  |  1995-02-13  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4. pgm(5)                      PBM Plus                       pgm(5)
  5.  
  6.  
  7.  
  8. NAME
  9.      pgm - portable graymap file format
  10.  
  11. DESCRIPTION
  12.      The portable graymap format is a lowest common denominator
  13.      grayscale file format.  The definition is as follows:
  14.  
  15.      - A "magic number" for identifying the file type.  A pgm
  16.        file's magic number is the two characters "P2".
  17.  
  18.      - Whitespace (blanks, TABs, CRs, LFs).
  19.  
  20.      - A width, formatted as ASCII characters in decimal.
  21.  
  22.      - Whitespace.
  23.  
  24.      - A height, again in ASCII decimal.
  25.  
  26.      - Whitespace.
  27.  
  28.      - The maximum gray value, again in ASCII decimal.
  29.  
  30.      - Whitespace.
  31.  
  32.      - Width * height gray values, each in ASCII decimal, between
  33.        0 and the specified maximum value, separated by whi-
  34.        tespace, starting at the top-left corner of the graymap,
  35.        proceding in normal English reading order.  A value of 0
  36.        means black, and the maximum value means white.
  37.  
  38.      - Characters from a "#" to the next end-of-line are ignored
  39.        (comments).
  40.  
  41.      - No line should be longer than 70 characters.
  42.  
  43.      Here is an example of a small graymap in this format:
  44.  
  45.      P2
  46.      # feep.pgm
  47.      18 7
  48.      15
  49.      0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0
  50.      0  3  3  3  3  0  0  7  7  7  7  0  0 11 11 11 11  0
  51.      0  3  0  0  0  0  0  7  0  0  0  0  0 11  0  0  0  0
  52.      0  3  3  3  0  0  0  7  7  7  0  0  0 11 11 11  0  0
  53.      0  3  0  0  0  0  0  7  0  0  0  0  0 11  0  0  0  0
  54.      0  3  0  0  0  0  0  7  7  7  7  0  0 11 11 11 11  0
  55.      0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0  0
  56.  
  57.      Programs that read this format should be as lenient as pos-
  58.      sible, accepting anything that looks remotely like a gray-
  59.      map.
  60.  
  61.  
  62.  
  63. Printed 5/25/90          01 August 1989                         1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. pgm(5)                      PBM Plus                       pgm(5)
  71.  
  72.  
  73.  
  74.      There is also a variant on the format, available by setting
  75.      the RAWBITS option at compile time.  This variant is dif-
  76.      ferent in the following ways:
  77.  
  78.      - The "magic number" is "P5" instead of "P2".
  79.  
  80.      - The gray values are stored as plain bytes, instead of
  81.        ASCII decimal.
  82.  
  83.      - No whitespace is allowed in the grays section.
  84.  
  85.      - The files are smaller and many times faster to read and
  86.        write.
  87.  
  88.      Note that this raw format can only be used for maxvals less
  89.      than or equal to 255.  If you use the PGM library and try to
  90.      write a file with a larger maxval, it will automatically
  91.      fall back on the slower but more general ASCII format.
  92.  
  93. SEE ALSO
  94.      fitstopgm(1), fstopgm(1), hipstopgm(1), psidtopgm(1),
  95.      rawtopgm(1), tifftopgm(1), pgmenhance(1), pgmhist(1),
  96.      pgmnorm(1), pgmtofits(1), pgmtopbm(1), pgmtops(1), pnm(5),
  97.      pbm(5), ppm(5)
  98.  
  99. AUTHOR
  100.      Copyright (C) 1989 by Jef Poskanzer.
  101.  
  102.      Permission to use, copy, modify, and distribute this
  103.      software and its documentation for any purpose and without
  104.      fee is hereby granted, provided that the above copyright
  105.      notice appear in all copies and that both that copyright
  106.      notice and this permission notice appear in supporting docu-
  107.      mentation.  This software is provided "as is" without
  108.      express or implied warranty.
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Printed 5/25/90          01 August 1989                         2
  130.  
  131.  
  132.  
  133.